| PRPM_HD996000ON Provider Organization Search Query |
(Link to Excel View) Derived from RMIM: PRPM_RM996000ON |
||||||||
| ParameterList | |||||||||
| address [0..1] (Address) |
Design Comments: Address City in relation to the roleClass being queried upon Rationale: Supports the business requirement to identify the specified roleClass being queried upon |
||||||||
| alternateIdentifier [0..1] (AlternateIdentifier) | |||||||||
| languageOption [0..1] (LanguageOption) | |||||||||
| organizationActiveIndicator [0..1] (OrganizationActiveIndicator) | |||||||||
| providerLHIN [0..1] (ProviderLHIN) |
Design Comments: Specifies the LHIN Number to search on. Rationale: Allows for the retrieval of Organization providers within a specific LHIN.. |
||||||||
| providerOrganizationID [0..1] (ProviderOrganizationID) |
Design Comments: This is the identifier for the organization provider for which the query is searching. Multiple ids can be specified through repetition of this parameter. Rationale: Supports the business requirement to identify the specified roleClass being queried upon |
||||||||
| providerOrganizationName [0..1] (ProviderOrganizationName) |
Design Comments: Name in relation to the roleClass being queried upon Rationale: Supports the business requirement to identify the specified roleClass being queried upon |
||||||||
| providerOrganizationRole [0..1] (ProviderOrganizationRole) |
Design Comments: This parameter is constrained to values from the HealthCareProviderRoleType Rationale: Supports the business requirement to identify the specified roleClass being queried upon |
||||||||
| searchOption [1..1] (SearchOption) | |||||||||
| telecom [0..1] (Telecom) | |||||||||
| Address |
Design Comments: Address City in relation to the roleClass being queried upon Rationale: Supports the business requirement to identify the specified roleClass being queried upon |
||||||||
| value [1..1] (M) ParameterItem (AD.SEARCH) |
Design Comments: The address of the address for the organization when playing the role of healthcare provider. UsageNotes: Only City, Postal Code and Address Line are allowed in this Release. The search is also done on alternate city names, e.g. Toronto/North York/Willowdale Rationale: Mandatory attribute supports the identification of the organization provider. Allows retrieving all records associated with a particular address for the Provider Organization's Role. |
||||||||
| AlternateIdentifier | |||||||||
| value [1..1] (M) ParameterItem (II.PUBLIC) |
Design Comments: Indicates an identifier (other than the UPI assign to the Provider Organization. E.g. Stakeholder Number (SN) assigned to the provider record by CPDB. Rationale: Allows identification of providers by secondary identification numbers. |
||||||||
| LanguageOption | |||||||||
| value [0..1] ParameterItem (CV) {CNE:D:DisplayLanguage} |
Design Comments: Indicates the language in which the requester wishes to receive the response of the query. Rationale: Allows a requester to determine the preferred official language for the requested information. |
||||||||
| OrganizationActiveIndicator | |||||||||
| value [1..1] (M) ParameterItem (CV) {CNE:D:RoleStatus} |
Design Comments: Organization’s active indicator/status code. |
||||||||
| ProviderLHIN |
Design Comments: Specifies the LHIN Number to search on. Rationale: Allows for the retrieval of Organization providers within a specific LHIN.. |
||||||||
| value [1..1] (M) ParameterItem (ST) {CWE:D:QueryParameterValue} |
Design Comments: Indicates that the query response is to be filted to only include provider role addresses with the associated postal area codes within the specified LHIN. Rationale: Supports filtering for specific provider information. |
||||||||
| ProviderOrganizationID |
Design Comments: This is the identifier for the organization provider for which the query is searching. Multiple ids can be specified through repetition of this parameter. Rationale: Supports the business requirement to identify the specified roleClass being queried upon |
||||||||
| value [1..1] (M) ParameterItem (II.PUBLIC) |
Design Comments: A unique identifier for an organization in a specific provider role. Rationale: Allows retrieving all records associated with a particular identifier for the Provider Organization's Role. |
||||||||
| ProviderOrganizationName |
Design Comments: Name in relation to the roleClass being queried upon Rationale: Supports the business requirement to identify the specified roleClass being queried upon |
||||||||
| value [1..1] (M) ParameterItem (ST) {CWE:D:QueryParameterValue} |
Design Comments: The provider’s name pertaining to the specific healthcare provider role. UsageNotes: If language is EN, search EN names only. If language is FR, search FR names first and then if there are no results, search EN names. Search Type: “Begins With”. Rationale: Mandatory attribute supports the identification of the organization provider Allows retrieving all records associated with a particular name for a Provider Organization Role. |
||||||||
| ProviderOrganizationRole |
Design Comments: This parameter is constrained to values from the HealthCareProviderRoleType Rationale: Supports the business requirement to identify the specified roleClass being queried upon |
||||||||
| value [1..1] (M) ParameterItem (CV) {CNE:V:AssignedRoleType} |
Design Comments: The code identifying the specific organization provider role. Rationale: Allows retrieving all records associated with a particular type of Provider Organization Role. |
||||||||
| SearchOption | |||||||||
| value [1..1] (M) ParameterItem (CV) {CNE:D:ProviderorganizationSearchOptionType} |
Design Comments: Indicates the type of provider organization search. Valid codes are: 1 - search by org name 2 - search by org role 3 - search by LHIN 4 - search by UPI 5 - search by Alt ID Allows for transmitting search pattern to he back-end to indicate required action Rationale: Allows for transmitting search pattern to the back-end to indicate required action |
||||||||
| Telecom | |||||||||
| value [1..1] (M) ParameterItem (TEL) |
Design Comments: Organization’s telephone or fax number. UsageNotes: Only telephone and fax numbers are allowed in this release. |
||||||||